home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / idcform.zip / IDCFORM.DOC < prev    next >
Text File  |  1989-06-26  |  5KB  |  167 lines
  1.  
  2.  
  3.  
  4.  
  5.                   IDCform
  6.                 
  7.     
  8.               Copyright 1989 Infinity Design Concepts Inc
  9.  
  10.                     ALL RIGHTS RESERVED
  11.  
  12.                         1052 Parkway Drive
  13.  
  14.                  Louisville, Kentucky 40217-2333
  15.  
  16.                   Voice: (502)636-1234    Data: (502)635-5471
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.     This program is SHAREWARE and as such is user supported software.
  26.     If you find yourself using this software on a regular basis, then 
  27.     you are    requested to purchase a copy. IDCform is copyrighted software
  28.     and is the property of IDC. IDC makes no warranty as to the
  29.     suitability of this software for any specific purpose.
  30.  
  31.  
  32.         SHAREWARE REGISTRATION FEE: $15.00
  33.  
  34.  
  35.  
  36.                                  OVERVIEW
  37.  
  38.         IDCform is a DOOR program that may be executed by any BBS software
  39.     that can call external programs (such as GT's DOOR system). The
  40.     program intercepts all DOS vectors that would allow the user to
  41.     break out of the program, thus protecting BBS integrity. A template
  42.     file is constructed as input to the program. This template file
  43.     describes the information that is to be obtained from the user.
  44.     If the user decides to save his answers, then the information is
  45.     written to an ASCII text delimited file (SDF).
  46.  
  47.  
  48.  
  49.     Command line syntax: IDCFORM <infile> <outfile>
  50.  
  51.     This program will take keyboard input that is formatted according
  52.     to a template file <infile>. The format of the template file is
  53.     as follows;
  54.  
  55.     %date    
  56.     {  header text  }
  57.     prompt for line 1: [-----]
  58.     prompt for line 2: [-----]
  59.     etc.
  60.     
  61.     The {} characters are reserved and may not be used within the
  62.     file except to denote the header.
  63.     The [] characters are reserved and may not be used within the
  64.     file except to denote the format of the string to be entered.
  65.     Each prompt line must be terminated with a ":" as shown above,
  66.     this too, is a reserved character.
  67.     
  68.     When invoked, IDCFORM will read the <infile> file, display
  69.     the text within the {} as a header. Then the first prompt line
  70.     will be displayed up to and including the ":".
  71.     Then the user will be allowed to enter a response string whose
  72.     format is controlled by the characters within the []. The format
  73.     may be controlled by the following characters on a character by
  74.     character basis, similar to dBASE formatting;
  75.     
  76.         ! - causes input character to be converted to uppercase
  77.         # - allows only numeric entry
  78.         ANY OTHER CHARACTER - allows anything to be entered
  79.     
  80.     Note that all control characters are filtered out and all
  81.     character codes equal to or above 127 (DEL) are also filtered out.
  82.  
  83.  
  84.     RESERVED CHARACTERS    %{}[]:
  85.  
  86.     After the form is completed, the user is asked if he wishes to
  87.     save his answers. If he chooses to save the answers, then the
  88.     text is formatted and appended to the <outfile> file specified
  89.     on the command line. Each record is written in an ASCII delimited
  90.     format, that is, each field is separated by a comma and each
  91.     record is delimited with a CR,LF sequence (SDF format).
  92.     Note that the comma character is disallowed when entering text, 
  93.     since it will be the field delimiter. Note also, that if <outfile> 
  94.     does not exist, it will be created automatically.
  95.  
  96.  
  97.                           ADDING A DATE STAMP
  98.  
  99.     Note also that the current date can be added to the
  100.     end of the data in "00/00/00" format if the %Date string
  101.     is located at the beginning of the <infile> file.
  102.  
  103.  
  104.                              SAMPLE FILE    
  105.     
  106.  
  107. %date - says add date.
  108.  
  109.     Note that any characters in the file that are ahead of the first 
  110.     squiggly bracket character will be ignored, with the exception of
  111.     the date string above.
  112.  
  113. {
  114.  
  115.                       IDC Purchase Order Form
  116. }
  117. First Name: [!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!]
  118. Last Name: [!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!]
  119. Address: [!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!]
  120. City: [!!!!!!!!!!!!!!!!!!!!]
  121. State: [!!]
  122. Zip: [#####-####]
  123. Phone: [###-###-#########]
  124. Credit Card  VISA or MC  (VS/MC): [!!]
  125. Card Number: [###################]
  126. Expiration date  month/year: [##/##]
  127. Product(s) you wish to order: [----------------------------------------------]
  128. Disk format 3.5" or 5.25" (3/5): [#]
  129. Comments/Special instructions: [---------------------------------------------]
  130.  
  131.  
  132.  
  133.  
  134.  
  135.                             ERRORLEVEL RETURNS
  136.             
  137.     IDCform returns information about what transpired during the
  138.     IDCform session. If IDCform is executed from a batch file, then
  139.     this information can be used for other features, such as writing
  140.     a parallel file of user names that should match name for name
  141.     the names in the <outfile>. This can be used to spot abusive users.
  142.     GT, for example, always stores the last callers name in the 
  143.     GTUSER.BBS file, thus you could use the following command to
  144.     update the parallel file;
  145.  
  146.  
  147.     TYPE GTUSER.BBS >> TRACK.BBS
  148.     
  149.     This would append the current users name to the TRACK.BBS file.
  150.     This action can be made contigent upon the user saving his
  151.     answers by utilizing the following errorlevels.
  152.  
  153.  
  154.        ERRORLEVEL   MEANING
  155.         0 - all went OK, answers saved in <outfile>
  156.         1 - <infile> not present on command line or unable to read
  157.         2 - user did not want to save his answers
  158.         3 - file format error in <infile>
  159.         4 - <outfile> not present on command line or unable to read
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166. <end file>
  167.